home *** CD-ROM | disk | FTP | other *** search
/ Chip: 2005 Utilities / CHIP Utilities 2005 / CHIP Utilities 2005.iso / dosapps / freedos / doc / htmlhelp / readme < prev   
Encoding:
Text File  |  2003-07-17  |  3.8 KB  |  141 lines
  1.  
  2.                     HTML Help System for FreeDOS
  3.                     ============================
  4.                             Version 1.0.1
  5.  
  6.  
  7. See also the files COPYING, BUGS and HISTORY.
  8.  
  9. Contents
  10. --------
  11. 0 What's New
  12. 1 Introduction
  13. 2 Copyrights
  14. 3 Usage
  15. 4 Contacts
  16. 5 Building HTML Help Viewer
  17. 6 How to include new HTML files
  18. 7 HTML Tags supported by the Viewer
  19.  
  20. 0 What's New
  21. ------------
  22. The replacement help content is here!
  23. Included is:
  24.  
  25. - A new version of the help viewer: version 5.2.1
  26.   The command line access of help topics
  27.   works faster, and 84-key keyboard support added.
  28.   See HISTORY for a full list of changes.
  29.  
  30. - the html file set, FreeDOS help (hhstndrd 1.0.1).
  31.   Updated and Expanded.
  32.  
  33. 1 Introduction
  34. --------------
  35. This is the FreeDOS clone of the MS-DOS 6.22 help command.
  36.  
  37.  
  38. 2 Copyrights
  39. ------------
  40. The HTML Help viewer is Copyright (c) Express Software 1998-2003,
  41. protected under the Express Software Public License Agreement (see the
  42. file COPYING).
  43.  
  44. The HTML Help content is a set of many files with various copyrights.
  45. The license for most of them is the GNU Free Documentation License,
  46. the licenses for all others will be in the same spirit as the GNU FDL.
  47. See the file HELP\FDL.TXT.
  48.  
  49.  
  50. 3 Usage
  51. -------
  52. To start the interactive help viewer (found in /bin) just type:
  53.  
  54.    HELP
  55.  
  56. and the contents page will be displayed. The standard set of html files
  57. can be browsed from here. To search for help on a particular
  58. topic, simply type:
  59.  
  60.    HELP [topic]
  61.  
  62. You can give a file name:
  63.  
  64.    HELP [filename]
  65.    HELP /Lfilename
  66.  
  67. If the /L switch is generally faster; with /L help won't check whether
  68. the filename is a topic first. To completely override the /help folder,
  69. use the /O switch:
  70.  
  71.    HELP /O[x:][path][filename]
  72.  
  73. For more information on using help, type
  74.  
  75.    HELP help
  76.  
  77. or
  78.  
  79.    HELP /?
  80.  
  81.  
  82. 4 Contacts
  83. ----------
  84. The FreeDOS website:
  85.        http://www.freedos.org
  86.  
  87. FreeDOS discussion list:
  88.        fd-dev@topica.com
  89.  
  90. The maintainer:
  91.        Rob Platt (worldwiderob@yahoo.co.uk)
  92.  
  93. The original developer of the viewer program:
  94.       Joe Cosentino (onehardmarine@attbi.com)
  95.  
  96.  
  97. 5 Building the HTML Help viewer
  98. -------------------------------
  99. The help.exe binary is included for those who do not wish to modify help.
  100.  
  101. It was built with "Borland Turbo C++ 3.0 for DOS", MASM, and TLINK, and uses
  102. Borland's Make.
  103.  
  104. TASMHELP.MAK is included for those with the TASM assembler, but this hasn't
  105. been tested for a bit. CONIO.OBJ should have been included with the source
  106. code, so it is not necessary for you to have an assembler unless you wish to
  107. modify the low level video (which is in conio.asm).
  108.  
  109. HELP.PRJ is a "Turbo C++ 3.0 for DOS" project file. This has been set up for
  110. debugging, and takes advantage of the debugging capabilities in the
  111. TC++ IDE. However, all release versions should be produced by compiling
  112. from the command line. This produces the most efficient code.
  113. Running RELEASE.BAT does this and cleans up the files correctly.
  114.  
  115. RELEASE.BAT automatically runs the GNU indent program on the source code,
  116. to reformat it to the FreeDOS coding conventions. For this to work,
  117.  
  118. Links to the indent program and public domain version of MASM can be
  119. found at:
  120.  
  121.    http://projects.freedos.net/htmlhelp
  122.  
  123.  
  124. 6 How to include new HTML files
  125. -------------------------------
  126. If you wish to contribute to the help files, write a translation etc,
  127. you should first make contact by mailing the FreeDOS discussion forum,
  128. fd-dev@topica.com or to the maintainer at worldwiderob@yahoo.co.uk
  129.  
  130. There is a set of guidelines for authors in the html help content,
  131. listed under the miscellaneous section of index.htm.
  132.  
  133.  
  134. 7 HTML Tags supported by the Viewer
  135. -----------------------------------
  136. You can get to the file:
  137.  
  138.    HELP\HHSTNDRD\AUTHORS\TAGS.HTM
  139.  
  140. from the Authors' Resources section in the hhstndrd file set.
  141.